gh-101100: Document zlib public constants to fix reference warnings
#139835
+133
−4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AA-Turner
reviewed
Oct 9, 2025
AA-Turner
reviewed
Oct 9, 2025
| zlib's functions have many options and often need to be used in a particular | ||
| order. This documentation doesn't attempt to cover all of the permutations; | ||
| consult the zlib manual at http://www.zlib.net/manual.html for authoritative | ||
| consult the `zlib manual <https://www.zlib.net/manual.html>`_ for authoritative |
There was a problem hiding this comment.
Note, bare links in source text are recognised by reST (unlike markdown), so this change is optional.
Suggested change
| consult the `zlib manual <https://www.zlib.net/manual.html>`_ for authoritative | |
| consult the `zlib manual <https://www.zlib.net/manual.html>`__ for authoritative |
See as they have references in the text (e.g., the compression levels), I would assume that was the intention. |
hugovk
reviewed
Oct 9, 2025
Co-authored-by: Hugo van Kemenade <[email protected]>
vstinner
reviewed
Oct 9, 2025
vstinner
reviewed
Oct 9, 2025
vstinner
approved these changes
Oct 9, 2025
|
Thanks for the reviews Victor! |
Co-authored-by: Victor Stinner <[email protected]>
vstinner
added
needs backport to 3.13
|
Thanks @StanFromIreland for the PR, and @vstinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Oct 10, 2025
…rnings (pythonGH-139835) (cherry picked from commit c7f1da97eb4639a17fb01ef122155bab2f262a34) Co-authored-by: Stan Ulbrych <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Victor Stinner <[email protected]>
|
Sorry, @StanFromIreland and @vstinner, I could not cleanly backport this to |
|
GH-139910 is a backport of this pull request to the 3.14 branch. |
vstinner
added a commit
that referenced
this pull request
Oct 10, 2025
…arnings (GH-139835) (#139910) gh-101100: Document `zlib` public constants to fix reference warnings (GH-139835) (cherry picked from commit c7f1da9) Co-authored-by: Stan Ulbrych <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Victor Stinner <[email protected]>
StanFromIreland
added a commit
to StanFromIreland/cpython
that referenced
this pull request
Oct 10, 2025
…rnings (python#139835) Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Victor Stinner <[email protected]> (cherry picked from commit c7f1da9)
StanFromIreland
added a commit
to StanFromIreland/cpython
that referenced
this pull request
Oct 10, 2025
…ence warnings (pythonGH-139835) (cherry picked from commit c7f1da9) Co-authored-by: Stan Ulbrych <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Victor Stinner <[email protected]>
|
GH-139912 is a backport of this pull request to the 3.13 branch. |
vstinner
added a commit
that referenced
this pull request
Oct 10, 2025
…nings (GH-139835) (#139912) * gh-101100: Document `zlib` public constants to fix reference warnings (#139835) Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Victor Stinner <[email protected]> (cherry picked from commit c7f1da9) * [3.13] gh-101100: Document `zlib` public constants to fix reference warnings (GH-139835) (cherry picked from commit c7f1da9) Co-authored-by: Stan Ulbrych <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Victor Stinner <[email protected]> --------- Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Victor Stinner <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Also included, converting links to
httpsand wrapping a long line.📚 Documentation preview 📚: https://cpython-previews--139835.org.readthedocs.build/